<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>sysmonpsv: xsysmonpsv_intr_example.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">sysmonpsv
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xsysmonpsv__intr__example_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xsysmonpsv_intr_example.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file contains a design example using the driver functions of the System Monitor driver. </p>
<p>The example here shows the driver/device in intr mode to check the on-chip temperature and voltages.</p>
<dl class="section note"><dt>Note</dt><dd></dd></dl>
<p>This examples also assumes that there is a STDIO device in the system.</p>
<pre></pre><pre>MODIFICATION HISTORY:</pre><pre>Ver   Who    Date     Changes
</p>
<hr/>
<p>
1.1   aad    2/7/19   First release
1.2   aad    3/19/20  Fixed the interrupt disable flag
2.3   aad    9/28/21  Force generate of interrupt.
3.0   cog    03/25/21 Driver Restructure
4.0   se     11/10/22 Secure and Non-Secure mode integration
5.0   se     08/01/24 Added new APIs to enable, set and get averaging for
                      voltage supplies and temperature satellites.
5.1   se     03/03/25 Compiler warnings fixed</pre><pre></pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a08f29d1a3ede32c28ff1b454b3b68a28"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xsysmonpsv__intr__example_8c.html#a08f29d1a3ede32c28ff1b454b3b68a28">SysMonPsvIntrExample</a> ()</td></tr>
<tr class="memdesc:a08f29d1a3ede32c28ff1b454b3b68a28"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function runs a test on the System Monitor device using the driver APIs.  <a href="#a08f29d1a3ede32c28ff1b454b3b68a28">More...</a><br/></td></tr>
<tr class="separator:a08f29d1a3ede32c28ff1b454b3b68a28"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af12aab9180dfd06b3eae318f3da5ea06"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xsysmonpsv__intr__example_8c.html#af12aab9180dfd06b3eae318f3da5ea06">Temp_CallbackFunc</a> (void *data)</td></tr>
<tr class="memdesc:af12aab9180dfd06b3eae318f3da5ea06"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback function to notify temperature event.  <a href="#af12aab9180dfd06b3eae318f3da5ea06">More...</a><br/></td></tr>
<tr class="separator:af12aab9180dfd06b3eae318f3da5ea06"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a738ce812f85a5db41509fe66e9aaa9fe"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xsysmonpsv__intr__example_8c.html#a738ce812f85a5db41509fe66e9aaa9fe">Supply_CallbackFunc</a> (void *data)</td></tr>
<tr class="memdesc:a738ce812f85a5db41509fe66e9aaa9fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback function to notify supply event.  <a href="#a738ce812f85a5db41509fe66e9aaa9fe">More...</a><br/></td></tr>
<tr class="separator:a738ce812f85a5db41509fe66e9aaa9fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a840291bc02cba5474a4cb46a9b9566fe"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xsysmonpsv__intr__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main</a> (void)</td></tr>
<tr class="memdesc:a840291bc02cba5474a4cb46a9b9566fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main function that invokes the intr example in this file.  <a href="#a840291bc02cba5474a4cb46a9b9566fe">More...</a><br/></td></tr>
<tr class="separator:a840291bc02cba5474a4cb46a9b9566fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a840291bc02cba5474a4cb46a9b9566fe"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int main </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Main function that invokes the intr example in this file. </p>
<dl class="section return"><dt>Returns</dt><dd>- XST_SUCCESS if the example has completed successfully.<ul>
<li>XST_FAILURE if the example has failed. </li>
</ul>
</dd></dl>

<p>References <a class="el" href="xsysmonpsv__intr__example_8c.html#a08f29d1a3ede32c28ff1b454b3b68a28">SysMonPsvIntrExample()</a>.</p>

</div>
</div>
<a class="anchor" id="a738ce812f85a5db41509fe66e9aaa9fe"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Supply_CallbackFunc </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>data</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Callback function to notify supply event. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">Data</td><td>is the data needed by the callback function. </td></tr>
  </table>
  </dd>
</dl>

<p>Referenced by <a class="el" href="xsysmonpsv__intr__example_8c.html#a08f29d1a3ede32c28ff1b454b3b68a28">SysMonPsvIntrExample()</a>.</p>

</div>
</div>
<a class="anchor" id="a08f29d1a3ede32c28ff1b454b3b68a28"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int SysMonPsvIntrExample </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function runs a test on the System Monitor device using the driver APIs. </p>
<p>This function does the following tasks:</p>
<ul>
<li>Initiate the System Monitor device driver instance</li>
<li>Enable OT interrupt</li>
<li>Setup call back for interrupts</li>
<li>Read supply configuration.</li>
<li>Read the latest on-chip temperatures and confiured supplies</li>
</ul>
<dl class="section return"><dt>Returns</dt><dd>- XST_SUCCESS if the example has completed successfully.<ul>
<li>XST_FAILURE if the example has failed. </li>
</ul>
</dd></dl>

<p>References <a class="el" href="xsysmonpsv__intr__example_8c.html#a738ce812f85a5db41509fe66e9aaa9fe">Supply_CallbackFunc()</a>, <a class="el" href="xsysmonpsv__intr__example_8c.html#af12aab9180dfd06b3eae318f3da5ea06">Temp_CallbackFunc()</a>, <a class="el" href="xsysmonpsv__services_8c.html#a27ee2cbf4e86a5e66f8ed744187a805f">XSysMonPsv_EnableVoltageEvents()</a>, <a class="el" href="group__sysmonpsv__api.html#ga67c461a10a691c449c71cab32fac6a48">XSysMonPsv_GetSupplyThresholdLower()</a>, <a class="el" href="group__sysmonpsv__api.html#ga5b0151be3a224dd63fea642c1fe585ad">XSysMonPsv_GetSupplyThresholdUpper()</a>, <a class="el" href="group__sysmonpsv__api.html#ga2c1a60d48742260bd94e48ddfa765923">XSysMonPsv_GetTempThresholdLower()</a>, <a class="el" href="group__sysmonpsv__api.html#gaaff6620f6d924de4cc4d872ec1372239">XSysMonPsv_GetTempThresholdUpper()</a>, <a class="el" href="group__sysmonpsv__api.html#gad9a7e5df580de9e887d2a32e63506af6">XSysMonPsv_ReadSupplyProcessed()</a>, <a class="el" href="group__sysmonpsv__api.html#gadae2aa6363d44df1bd536d34b057e005">XSysMonPsv_ReadSupplyRaw()</a>, <a class="el" href="group__sysmonpsv__api.html#ga68d41d5890402def819f92c449b6aa64">XSysMonPsv_ReadTempProcessed()</a>, <a class="el" href="group__sysmonpsv__api.html#ga215a6613a637b848cdd432f6f5678c15">XSysMonPsv_ReadTempRaw()</a>, <a class="el" href="group__sysmonpsv__api.html#ga91085a71b3a47feced9334972d44fe42">XSysMonPsv_SetSupplyThresholdLower()</a>, <a class="el" href="group__sysmonpsv__api.html#ga9ad66ba4141b25c3c0d88d2cc9b6da65">XSysMonPsv_SetSupplyThresholdUpper()</a>, <a class="el" href="group__sysmonpsv__api.html#gaa8f51a313ccb628e58b51568219d0e5b">XSysMonPsv_SetTempMode()</a>, <a class="el" href="group__sysmonpsv__api.html#ga149bfc9f51bcb73c25200d3ba1310b89">XSysMonPsv_SetTempThresholdLower()</a>, <a class="el" href="group__sysmonpsv__api.html#ga023579c86e80a20a04147ac55c77f841">XSysMonPsv_SetTempThresholdUpper()</a>, <a class="el" href="xsysmonpsv_8h.html#a0b6adba4156901193b4901075da2b32e">XSysMonPsv_Supply_Arr</a>, <a class="el" href="xsysmonpsv__common_8h.html#a121b9e0621d3f6c2a9b70e2081bb91beab55778d23fd3e17972e5f218cea9a7e8">XSYSMONPSV_TEMP_EVENT</a>, <a class="el" href="xsysmonpsv__common_8h.html#adfe9f0bbf776d4b6c29403ffbd49bf30ae89a5e61e7817a759c6a8e4c041cd394">XSYSMONPSV_TEMP_MAX</a>, and <a class="el" href="xsysmonpsv__common_8h.html#adfe9f0bbf776d4b6c29403ffbd49bf30af47c7b392627575724efb983f3e1f2b3">XSYSMONPSV_TEMP_MIN</a>.</p>

<p>Referenced by <a class="el" href="xsysmonpsv__intr__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
<a class="anchor" id="af12aab9180dfd06b3eae318f3da5ea06"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Temp_CallbackFunc </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>data</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Callback function to notify temperature event. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">Data</td><td>is the data needed by the callback function. </td></tr>
  </table>
  </dd>
</dl>

<p>Referenced by <a class="el" href="xsysmonpsv__intr__example_8c.html#a08f29d1a3ede32c28ff1b454b3b68a28">SysMonPsvIntrExample()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
